<?php
/**
 * The MIT License
 *
 * Copyright (c) <year> <copyright holders>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @author Damiano Ciarla
 * @package core
 * @subpackage plugin/abstract
 */
abstract class BXD_Plugin_Abstract_Config
{
	/**
	 * Cartella dove sarà memorizzato il plugin
	 *
	 * @var string
	 */
	public $folder;

	/**
	 * Nome del plugin
	 *
	 * @var string
	 */
	public $name;

	/**
	 * Lista delle classi che il plugin include
	 *
	 * @var array
	 */
	private $_class = array();

	/**
	 * Lista dei controller da includere
	 *
	 * @var array
	 */
	private $_controller = array();

	/**
	 * Lista delle view da includere
	 *
	 * @var array
	 */
	private $_view = array();

	/**
	 * Lista di tutto quello che riguarda js/css/img
	 *
	 * @var array
	 */
	private $_media = array();

	/**
	 * Metodo che aggiunge una classe alla dichiarazione di quelle presenti nel plugin
	 *
	 * @param string $className Nome della classe
	 * @param string $path Path completo dove è situata la classe
	 *
	 * <code>
	 * L'esempio seguente mostra come aggiungere una nuova classe alla configurazione del plugin
	 *
	 * $this->addClass("Init", "common/InitPlugin.php");
	 *
	 * La classe nell'esempio è dichiarata con il nome Init e si trova nella cartella 'common'
	 * all'interno del file InitPlugin.php
	 * </code>
	 */
	protected function addClass($className, $path)
	{
		$this->_class[$className] = $path;
	}

	/**
	 * Metodo che aggiunge un nuovo controller alla dichiarazione di quelli presenti nel plugin.
	 * È necessari specificare solamente il path per poterlo importare all'interno dell'applicazione
	 *
	 * @param string $path Path completo dove è situato il controller
	 *
	 * <code>
	 * L'esempio seguente mostra come aggiungere un nuovo controller alla configurazione del plugin
	 *
	 * $this->addController("PluginController.php");
	 *
	 * Questo esempio aggiungere questo controller nella cartella dei controller dell'applicazione
	 * </code>
	 */
	protected function addController($path)
	{
		$this->_controller[] = $path;
	}

	/**
	 * Metodo che aggiunge una classe alla dichiarazione di quelle presenti nel plugin
	 *
	 * @param string $className Nome della classe
	 * @param string $path Path completo dove è situata la classe
	 *
	 * <code>
	 * L'esempio seguente mostra come aggiungere una nuova classe alla configurazione del plugin
	 *
	 * $this->addClass("Init", "common/InitPlugin.php");
	 *
	 * La classe nell'esempio è dichiarata con il nome Init e si trova nella cartella 'common'
	 * all'interno del file InitPlugin.php
	 * </code>
	 */
	protected function addView($path)
	{
		$this->_view[] = $path;
	}

	/**
	 * Metodo che aggiunge una classe alla dichiarazione di quelle presenti nel plugin
	 *
	 * @param string $className Nome della classe
	 * @param string $path Path completo dove è situata la classe
	 *
	 * <code>
	 * L'esempio seguente mostra come aggiungere una nuova classe alla configurazione del plugin
	 *
	 * $this->addClass("Init", "common/InitPlugin.php");
	 *
	 * La classe nell'esempio è dichiarata con il nome Init e si trova nella cartella 'common'
	 * all'interno del file InitPlugin.php
	 * </code>
	 */
	protected function addMedia($path)
	{
		$this->_media[] = $path;
	}


	public function getClassList()
	{
		return $this->_class;
	}

	public function getControllerList()
	{
		return $this->_controller;
	}

	public function getViewList()
	{
		return $this->_view;
	}

	public function getMediaList()
	{
		return $this->_media;
	}
}
?>